/*
 * Copyright 2009 Max Kugland
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.splink.deepsplink.navigation {
	import org.splink.library.IFinalizable;

	/**
	 * An <code>IPageNavigationModel</code> implementation provides
	 * a method to return the subPages of the page it belongs to.
	 * It also provides a method to return the page id which need to be 
	 * selected. 
	 *
	 * The default implementation is <code>PageNavigationModel</code>
	 * 
	 * @see org.splink.deepsplink.navigation.PageNavigationModel
	 * @author Max Kugland
	 */
	public interface IPageNavigationModel extends IFinalizable {

		/**
		 * Returns an array of pageId Strings representing the id's of the
		 * <code>IPageNavigationModel</code>s subpages.
		 */
		function getSubPageIds() : Array;

		/**
		 * Computes which of the page navigation's subpages needs to be highlighted. 
		 * If no subpage id needs highlighting, and none of the parent pages is selected, 
		 * null is returned.
		 * 
		 * @param selectedPageId the id of the selected page
		 * @return one of the ids belonging the the page navigation model or null
		 */
		function getSelectedPageId(selectedPageId : String) : String;
	}
}
